.\"
.\" ----------------------------------------------------------------------------
.\" "THE BEER-WARE LICENSE" (Revision 42):
.\" <phk@login.dkuug.dk> wrote this file.  As long as you retain this notice you
.\" can do whatever you want with this stuff. If we meet some day, and you think
.\" this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
.\" ----------------------------------------------------------------------------
.\"
.\" 	$MirOS: src/lib/libc/hash/md5.3,v 1.4 2007/05/07 16:15:56 tg Exp $
.\" 	$OpenBSD: md5.3,v 1.9 2004/08/24 20:10:33 millert Exp $
.\"
.Dd April 29, 2004
.Dt MD5 3bsd
.Os
.Sh NAME
.Nm MD5Init ,
.Nm MD5Update ,
.Nm MD5Pad ,
.Nm MD5Final ,
.Nm MD5Transform ,
.Nm MD5End ,
.Nm MD5File ,
.Nm MD5FileChunk ,
.Nm MD5Data
.Nd calculate the RSA Data Security, Inc., ``MD5'' message digest
.Sh LIBRARY
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
.Lb libbsd
.Sh SYNOPSIS
.In sys/types.h
.In md5.h
(See
.Xr libbsd 7
for include usage.)
.Ft void
.Fn MD5Init "MD5_CTX *context"
.Ft void
.Fn MD5Update "MD5_CTX *context" "const uint8_t *data" "size_t len"
.Ft void
.Fn MD5Pad "MD5_CTX *context"
.Ft void
.Fn MD5Final "uint8_t digest[MD5_DIGEST_LENGTH]" "MD5_CTX *context"
.Ft void
.Fn MD5Transform "uint32_t state[4]" "uint8_t block[MD5_BLOCK_LENGTH]"
.Ft "char *"
.Fn MD5End "MD5_CTX *context" "char *buf"
.Ft "char *"
.Fn MD5File "const char *filename" "char *buf"
.Ft "char *"
.Fn MD5FileChunk "const char *filename" "char *buf" "off_t offset" "off_t length"
.Ft "char *"
.Fn MD5Data "const uint8_t *data" "size_t len" "char *buf"
.Sh DESCRIPTION
The MD5 functions calculate a 128-bit cryptographic checksum (digest)
for any number of input bytes.
A cryptographic checksum is a one-way
hash-function, that is, you cannot find (except by exhaustive search)
the input corresponding to a particular output.
This net result is a
.Dq fingerprint
of the input-data, which doesn't disclose the actual input.
.Pp
MD4 has been broken; it should only be used where necessary for
backward compatibility.
MD5 has not yet (1999-02-11) been broken, but recent attacks have cast
some doubt on its security properties.
The attacks on both MD4 and MD5
are both in the nature of finding
.Dq collisions
\- that is, multiple
inputs which hash to the same value; it is still unlikely for an attacker
to be able to determine the exact original input given a hash value.
.Pp
The
.Fn MD5Init ,
.Fn MD5Update ,
and
.Fn MD5Final
functions are the core functions.
Allocate an MD5_CTX, initialize it with
.Fn MD5Init ,
run over the data with
.Fn MD5Update ,
and finally extract the result using
.Fn MD5Final .
.Pp
The
.Fn MD5Pad
function can be used to apply padding to the message digest as in
.Fn MD5Final ,
but the current context can still be used with
.Fn MD5Update .
.Pp
The
.Fn MD5Transform
function is used by
.Fn MD5Update
to hash 512-bit blocks and forms the core of the algorithm.
Most programs should use the interface provided by
.Fn MD5Init ,
.Fn MD5Update
and
.Fn MD5Final
instead of calling
.Fn MD5Transform
directly.
.Pp
.Fn MD5End
is a wrapper for
.Fn MD5Final
which converts the return value to an MD5_DIGEST_STRING_LENGTH-character
(including the terminating '\e0')
.Tn ASCII
string which represents the 128 bits in hexadecimal.
.Pp
.Fn MD5File
calculates the digest of a file, and uses
.Fn MD5End
to return the result.
If the file cannot be opened, a null pointer is returned.
.Pp
.Fn MD5FileChunk
behaves like
.Fn MD5File
but calculates the digest only for that portion of the file starting at
.Fa offset
and continuing for
.Fa length
bytes or until end of file is reached, whichever comes first.
A zero
.Fa length
can be specified to read until end of file.
A negative
.Fa length
or
.Fa offset
will be ignored.
.Fn MD5Data
calculates the digest of a chunk of data in memory, and uses
.Fn MD5End
to return the result.
.Pp
When using
.Fn MD5End ,
.Fn MD5File ,
.Fn MD5FileChunk ,
or
.Fn MD5Data ,
the
.Ar buf
argument can be a null pointer, in which case the returned string
is allocated with
.Xr malloc 3
and subsequently must be explicitly deallocated using
.Xr free 3
after use.
If the
.Ar buf
argument is non-null it must point to at least MD5_DIGEST_STRING_LENGTH
characters of buffer space.
.Sh SEE ALSO
.Xr cksum 1 ,
.Xr md5 1 ,
.Xr adler32 3 ,
.Xr md4 3 ,
.Xr rmd160 3 ,
.Xr sfv 3 ,
.Xr sha1 3 ,
.Xr sha2 3 ,
.Xr suma 3 ,
.Xr tiger 3 ,
.Xr whirlpool 3
.Rs
.%A R. Rivest
.%T The MD4 Message-Digest Algorithm
.%O RFC 1186
.Re
.Rs
.%A R. Rivest
.%T The MD5 Message-Digest Algorithm
.%O RFC 1321
.Re
.Rs
.%A RSA Laboratories
.%T Frequently Asked Questions About today's Cryptography
.%O \&<http://www.rsa.com/rsalabs/faq/>
.Re
.Rs
.%A H. Dobbertin
.%T Alf Swindles Ann
.%J CryptoBytes
.%N 1(3):5
.%D 1995
.Re
.Rs
.%A MJ. B. Robshaw
.%T On Recent Results for MD4 and MD5
.%J RSA Laboratories Bulletin
.%N 4
.%D November 12, 1996
.Re
.Rs
.%A Hans Dobbertin
.%T Cryptanalysis of MD5 Compress
.Re
.Sh HISTORY
These functions appeared in
.Ox 2.0 .
.Sh AUTHORS
The original MD5 routines were developed by
.Tn RSA
Data Security, Inc., and published in the above references.
This code is derived from a public domain implementation written by Colin Plumb.
.Pp
The
.Fn MD5End ,
.Fn MD5File ,
.Fn MD5FileChunk ,
and
.Fn MD5Data
helper functions are derived from code written by Poul-Henning Kamp.
.Sh BUGS
Collisions have been found for the full versions of both MD4 and MD5
as well as strong attacks against the SHA-0 and SHA-1 family.
The use of
.Xr sha2 3 ,
or
.Xr rmd160 3
is recommended instead.
